docs: add release guide to documentation#434
Open
mojomex wants to merge 3 commits into
Open
Conversation
Signed-off-by: Max SCHMELLER <max.schmeller@tier4.jp>
Signed-off-by: Max SCHMELLER <max.schmeller@tier4.jp>
mojomex
force-pushed
the
docs/release-guide
branch
from
7a15b49 to
0647e98
Compare
Collaborator
Author
|
@SergioReyesSan @badai-nguyen @drwnz Friendly ping 🙇 As it's not mission critical, a quick check is enough. |
drwnz
requested changes
Jun 3, 2026
Collaborator
drwnz
left a comment
drwnz
left a comment
There was a problem hiding this comment.
Thanks for the PR. I added some comments and questions.
| 2. Follow the [Subsequent Releases](https://docs.ros.org/en/humble/How-To-Guides/Releasing/Subsequent-Releases.html) | ||
| guide to update the changelog, bump the version, and create pull requests to rosdistro. | ||
| 1. Update changelogs using `catkin_generate_changelog`, then PR and merge to `main`. | ||
| 2. Bump the version using `catkin_prepare_release` directly on `main`. |
Collaborator
There was a problem hiding this comment.
Our main is protected, so can you do this without changing settings anywhere? Or is this overridden somehow?
|
|
||
| !!! warning "Check for breaking changes" | ||
| As per the semantic versioning rules, the major/minor/patch version should be bumped based | ||
| on the type of changes in the release. Familiarize with [Semantic Versioning](https://semver.org/), |
Collaborator
There was a problem hiding this comment.
Suggested change
| on the type of changes in the release. Familiarize with [Semantic Versioning](https://semver.org/), | |
| on the type of changes in the release. Please familiarize yourself with [Semantic Versioning](https://semver.org/), |
| !!! warning "Check for breaking changes" | ||
| As per the semantic versioning rules, the major/minor/patch version should be bumped based | ||
| on the type of changes in the release. Familiarize with [Semantic Versioning](https://semver.org/), | ||
| and ensure to bump the version correctly in accordance with the changes in the release. |
Collaborator
There was a problem hiding this comment.
Suggested change
| and ensure to bump the version correctly in accordance with the changes in the release. | |
| and ensure the version is bumped correctly in accordance with the changes in the release. |
| guide to update the changelog, bump the version, and create pull requests to rosdistro. | ||
| 1. Update changelogs using `catkin_generate_changelog`, then PR and merge to `main`. | ||
| 2. Bump the version using `catkin_prepare_release` directly on `main`. | ||
| 3. Notify the ROS 2 ecosystem using `bloom-release`. Do this once per supported ROS 2 distribution, |
Collaborator
There was a problem hiding this comment.
Can only repository admins do this?
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
PR Type
Related Links
Description
This PR adds a "Cutting Releases" page to the "Contributing" section of the documentation.
Releases are now using the ROS 2 Bloom and Catkin tooling, and I already screwed up using it correctly for version
1.1.0, so documentation is definitely needed 😁Review Procedure
Build and serve docs with
then go to http://localhost:8000/nebula/contributing/cutting_releases/
Remarks
Pre-Review Checklist for the PR Author
PR Author should check the checkboxes below when creating the PR.
Checklist for the PR Reviewer
Reviewers should check the checkboxes below before approval.
Post-Review Checklist for the PR Author
PR Author should check the checkboxes below before merging.
CI Checks